<!doctype html>

<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>undoredostate.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>

<div class="clear"></div>

<h2><a href="closure_goog_editor_plugins_undoredostate.js.html">undoredostate.js</a></h2>

<pre class="prettyprint lang-js">
<a name="line1"></a>// Copyright 2008 The Closure Library Authors. All Rights Reserved.
<a name="line2"></a>//
<a name="line3"></a>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
<a name="line4"></a>// you may not use this file except in compliance with the License.
<a name="line5"></a>// You may obtain a copy of the License at
<a name="line6"></a>//
<a name="line7"></a>//      http://www.apache.org/licenses/LICENSE-2.0
<a name="line8"></a>//
<a name="line9"></a>// Unless required by applicable law or agreed to in writing, software
<a name="line10"></a>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,
<a name="line11"></a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a name="line12"></a>// See the License for the specific language governing permissions and
<a name="line13"></a>// limitations under the License.
<a name="line14"></a>
<a name="line15"></a>/**
<a name="line16"></a> * @fileoverview Code for an UndoRedoState interface representing an undo and
<a name="line17"></a> * redo action for a particular state change. To be used by
<a name="line18"></a> * {@link goog.editor.plugins.UndoRedoManager}.
<a name="line19"></a> *
<a name="line20"></a> */
<a name="line21"></a>
<a name="line22"></a>
<a name="line23"></a>goog.provide(&#39;goog.editor.plugins.UndoRedoState&#39;);
<a name="line24"></a>
<a name="line25"></a>goog.require(&#39;goog.events.EventTarget&#39;);
<a name="line26"></a>
<a name="line27"></a>
<a name="line28"></a>
<a name="line29"></a>/**
<a name="line30"></a> * Represents an undo and redo action for a particular state transition.
<a name="line31"></a> *
<a name="line32"></a> * @param {boolean} asynchronous Whether the undo or redo actions for this
<a name="line33"></a> *     state complete asynchronously. If true, then this state must fire
<a name="line34"></a> *     an ACTION_COMPLETED event when undo or redo is complete.
<a name="line35"></a> * @constructor
<a name="line36"></a> * @extends {goog.events.EventTarget}
<a name="line37"></a> */
<a name="line38"></a>goog.editor.plugins.UndoRedoState = function(asynchronous) {
<a name="line39"></a>  goog.base(this);
<a name="line40"></a>
<a name="line41"></a>  /**
<a name="line42"></a>   * Indicates if the undo or redo actions for this state complete
<a name="line43"></a>   * asynchronously.
<a name="line44"></a>   * @type {boolean}
<a name="line45"></a>   * @private
<a name="line46"></a>   */
<a name="line47"></a>  this.asynchronous_ = asynchronous;
<a name="line48"></a>};
<a name="line49"></a>goog.inherits(goog.editor.plugins.UndoRedoState, goog.events.EventTarget);
<a name="line50"></a>
<a name="line51"></a>
<a name="line52"></a>/**
<a name="line53"></a> * Event type for events indicating that this state has completed an undo or
<a name="line54"></a> * redo operation.
<a name="line55"></a> */
<a name="line56"></a>goog.editor.plugins.UndoRedoState.ACTION_COMPLETED = &#39;action_completed&#39;;
<a name="line57"></a>
<a name="line58"></a>
<a name="line59"></a>/**
<a name="line60"></a> * @return {boolean} Whether or not the undo and redo actions of this state
<a name="line61"></a> *     complete asynchronously. If true, the state will fire an ACTION_COMPLETED
<a name="line62"></a> *     event when an undo or redo action is complete.
<a name="line63"></a> */
<a name="line64"></a>goog.editor.plugins.UndoRedoState.prototype.isAsynchronous = function() {
<a name="line65"></a>  return this.asynchronous_;
<a name="line66"></a>};
<a name="line67"></a>
<a name="line68"></a>
<a name="line69"></a>/**
<a name="line70"></a> * Undoes the action represented by this state.
<a name="line71"></a> */
<a name="line72"></a>goog.editor.plugins.UndoRedoState.prototype.undo = goog.abstractMethod;
<a name="line73"></a>
<a name="line74"></a>
<a name="line75"></a>/**
<a name="line76"></a> * Redoes the action represented by this state.
<a name="line77"></a> */
<a name="line78"></a>goog.editor.plugins.UndoRedoState.prototype.redo = goog.abstractMethod;
<a name="line79"></a>
<a name="line80"></a>
<a name="line81"></a>/**
<a name="line82"></a> * Checks if two undo-redo states are the same.
<a name="line83"></a> * @param {goog.editor.plugins.UndoRedoState} state The state to compare.
<a name="line84"></a> * @return {boolean} Wether the two states are equal.
<a name="line85"></a> */
<a name="line86"></a>goog.editor.plugins.UndoRedoState.prototype.equals = goog.abstractMethod;
</pre>


</body>
</html>
